home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 36 / Amiga Format CD36 (1999-01-22)(Future Publishing)(GB)[!][issue 1999-02].iso / -seriously_amiga- / comms / other / yam2amirc / yam2amirc.txt < prev   
Text File  |  1998-12-07  |  6KB  |  216 lines
  1.  
  2.     YAM2AmIRC - The interface for YAM and AmIRC
  3.     ===========================================
  4.  
  5.  
  6.  
  7. · Introduction:
  8. ===============
  9.  
  10. I hate it to open YAM and look what kind of EMail arrived while I work
  11. with AmIRC. I could of course set up filters that play certain sounds
  12. on certain EMails, but still, I can't see whose EMail I got.
  13.  
  14. So I came to the idea of writing a little script that sends useful
  15. information to the AmIRC window, letting me easily see who EMails come
  16. from, without the need to open the YAM window.
  17.  
  18.  
  19.  
  20. · Features:
  21. ===========
  22.  
  23. - Display number of total/new/unread "Incoming" EMails in active AmIRC
  24.     window. 
  25. - Allows to set up patterns to match the "From" header and displays
  26.     the resulting emails.
  27. - Plays a soundfile even when AmIRC is not active.
  28. - Displaying of all New and Unread EMails in the Incoming folder.
  29. - AmIRC interface to control YAM2AmIRC from within itself, so you can at
  30.     any time check your Incoming folder.
  31. - Many configuration options, also for the sound player.
  32.  
  33.  
  34.  
  35. · Requires:
  36. ===========
  37.  
  38. - YAM2.0p5
  39. - AmIRC2.0 (should work with earlier versions also)
  40. - RexxMast active.
  41. - Optionally a soundplayer or MultiView with a correct sound datatype.
  42. - An Amiga computer, of course.
  43.  
  44.  
  45.  
  46. · Installation:
  47. ===============
  48.  
  49. - Copy YAM2AmIRC.rexx to the Rexx drawer within your YAM directory.
  50.  
  51. - Go to the YAM Confiruation - New Mail - Notification - Command, and
  52.     enter the following line:
  53.  
  54.     C:Run >NIL: SYS:Rexxc/Rx YAM:Rexx/YAM2AmIRC.rexx
  55.  
  56.   (Change the paths of Rx and YAM2AmIRC if neccesary)
  57.  
  58. - Go to the AmIRC menu - Settings - Lists - Alias, and enter the
  59.     follwing line:
  60.  
  61.     mail /rx YAM:Rexx/YAM2AmIRC.rexx 1 %p
  62.  
  63.   With that you can access YAM2AmIRC from within AmIRC.
  64.  
  65.  
  66. · Configuration:
  67. ================
  68.  
  69. Once you have installed the script, you will have to set up a few basic
  70. settings. Open the script with your favourite text editor (Ed, CygnusEd,
  71. etc.). You can set up several variables to your own needs:
  72.  
  73. - display & search
  74.  
  75.     Set these two variables according to the following:
  76.  
  77.     display=Y & search=Y   : Show Folder info and use search function.
  78.     display=Y & search=N   : Show Folder info and all New/Unread EMails.
  79.     display=N & search=Y/N : Display Folder info only.
  80.  
  81.  
  82. - searchfor
  83.     
  84.     This variable includes the patterns you want the script to notify to
  85.     you. If you use more than one pattern, seperate them with a space
  86.     only.
  87.  
  88.     Please note that the patterns are case sensitive and that only New
  89.     EMails in the "Incoming" folder will be checked.
  90.     Also, this option is not relevant if search is not set to "Y".
  91.  
  92.     Example:
  93.  
  94.     If you set the script to look for : ".de @infocanarias.com listserv@"
  95.  
  96.     You would be visually notified of emails like chatroom@yahoo.de ,
  97.     Pfauder@infocanarias.com , listserv@mermaid.net...
  98.  
  99.     Note:
  100.  
  101.     If you turn "Update Message Status" on (in Config/New Mail) then
  102.     YAM2AmIRC will inform only once about a new EMail you have on the
  103.     notify list. If you turn it off then the EMail will always show as
  104.     New, and therefore pop up every time YAM2AmIRC checks the Incoming
  105.     folder. 
  106.  
  107.  
  108. - linelength
  109.  
  110.     Max. length of the line to be displayed in the AmIRC window (useful
  111.     if your window is small, or big...). Default is 60.
  112.  
  113.  
  114. - playsound
  115.  
  116.     Set this to "Y" if you want to use the soundplay function.
  117.  
  118.  
  119. - soundplayer & soundfile & playeroptions
  120.  
  121.     Specify the player you use, the soundfile and any options.
  122.  
  123.     Example:
  124.  
  125.     soundplayer = "C:Play16"
  126.     soundfile = "YAM:INCOMING.WAV"
  127.     playeroptions = "OUTPUT=Paula14"
  128.  
  129.     would do the same as:  "C:Play16 YAM:INCOMING.WAV Paula14"
  130.  
  131.     (Please let me know if you want this way of setting up being changed)
  132.  
  133.  
  134.  
  135. · Usage:
  136. ========
  137.  
  138. Once it is installed, the script will activate every time you receive
  139. new EMail.
  140.  
  141.  
  142.  
  143. · AmIRC Interface:
  144. ==================
  145.  
  146. You can control YAM2AmIRC from within AmIRC, once the script is
  147. installed and the alias is set (see Installation). For that, you use the
  148. /mail command:
  149.  
  150.     /mail            - Display only folder info.
  151.     /mail new    - Display folder info and new pattern matching EMails.
  152.     /mail all    - Display folder info and all new or unread EMails.
  153.  
  154.  
  155.  
  156. · To do:
  157. ========
  158.  
  159. - More optimizations (once the YAM2.0 Arexx port is fully working).
  160. - MUI GUI for easy configuration of the settings (once I find out how
  161.     to do it :)
  162.  
  163.  
  164.  
  165. · Contact:
  166. ==========
  167.  
  168. If you have suggestions, comments or bug reports, send them to:
  169.  
  170. Frank Meyer-Pfauder
  171. EMail: Pfauder@infocanarias.com
  172.  
  173. Support Page: http://members.xoom.com/pfauder/yam2amirc.html
  174.  
  175.  
  176.  
  177. · Disclaimer:
  178. =============
  179.  
  180. This script is freeware. Feel free to give it away or copy it, but
  181. please keep the files together, and don't delete my name from the
  182. header ;)
  183.  
  184.  
  185.  
  186. · History:
  187. ==========
  188.  
  189. - v1.0    internal, first version.
  190.  
  191. - v1.1    internal, added linelength function and some minor bug fixes.
  192.  
  193. - v1.11    internal, made the script faster, changing some functions.
  194.  
  195. - v1.12  first public release, some minor optimizations and changes.
  196.  
  197. - v1.13    deleted an obsolete line. File is a little bit smaller.
  198.  
  199. - v1.2    made playback of soundfile optional, made pattern search
  200.             optional, script now checks for correct setup, corrected
  201.             line length bug, optimized code (much faster now).
  202.  
  203. - v1.21    again more optimized. Pattern comparing faster.
  204.  
  205. - v1.22    added port scan for AmIRC (thanks to Bossman^ for the advice).
  206.  
  207. - v1.23    changed the output a little bit. Minor changes to the manual.
  208.  
  209. - v2.0b  internal, rewritten code almost completely.
  210.             Added optional displaying of all new EMails, interface to use
  211.             YAM2AmIRC within AmIRC, sound player now configurable.
  212.  
  213. - v2.0    removed two bugs (only two, but bad ones...), changed the AmIRC
  214.             display color (now set to 1 (Highlight)). Optimized a few
  215.             lines.
  216.